/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.core.util.parser;

import java.text.MessageFormat;
import java.util.List;

/**
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public class ParseException extends Exception {
    
    private static final long serialVersionUID = -7161654007418975431L;
    private static final String MESSAGE_PREFIX = "Missing {0,choice,1#property|1<properties}: ";
    private static final String SEPARATOR = ", ";
    private List<String> missingProperties;
    
    public ParseException (List<String> missingProperties) throws IllegalArgumentException {
        super();
        if (missingProperties == null)
            throw new IllegalArgumentException("The missing properties list cannot be null");
        if (missingProperties.isEmpty())
            throw new IllegalArgumentException("The missing properties list cannot be empty");
        
        this.missingProperties = missingProperties;
    }

    public ParseException (String message, Throwable cause) {
        super(message,cause);
    }
    
    public ParseException (String message) {
        super(message);
    }
    
    public List<String> getMissingProperties () {
        return missingProperties;
    }
    
    public String getMessage () {
        String superClassMessage = super.getMessage();
        if (superClassMessage == null) {
            if (missingProperties != null) {
                StringBuilder builder = new StringBuilder(
                        MessageFormat.format(MESSAGE_PREFIX, missingProperties.size()));
                for (int i = 0; i < missingProperties.size(); i++) {
                    if (i > 0)
                        builder.append(SEPARATOR);
                    builder.append(missingProperties.get(i));
                }
                return builder.toString();
            }
        }
        return superClassMessage;
    }
}
